Working with Scenario Keys
Scenario keys define items in an application that vary every time a specific scenario is run. Keys can represent files, numbers, character strings or Boolean flags.
Keys are displayed in the Model tab in Project Explorer:
Right-click on the Keys section in Project Explorer
to add a new key.Scenario keys can be grouped by categories:
- Right-click on the Keys section in Project Explorer to add a category.
- Right-click on the category to add a Key to that Category.
To define/edit a key:
(see Keys Overview for detailed information about keys)
- Type a Name, Title and Description that describes the key.
- [Optional] Select a Color Label which can be used for filtering and managing purposes through Project Explorer.
- Select from the provided
options the key’s value type. Depending on the value type different settings
will be available for the key definition.
Note: If you specify a File Name type key, the Scenario Edit dialog will include a browse button to allow the file to be found using a standard Windows File Open dialog. The types of files to be browsed for can be defined by clicking the File Filters button. Scenario Manager will always make the All Files (*.*) category available. Update the File Filters if you want to define specific filters, such as Data Files (*.dat). - Select the Control type from the available options for that value type.
- Double-click on any of the
scenario keys available in the right panel of the window
,
to switch to and edit any of the keys.
- Click Apply to save the changes or Update to save the changes and close the Editor window.
Example for a File Name value type:
Setting up a key that will contain the fille path for the network used for assignment
- Define the key's Name, Title and Description
- Select File Name in the value type section
- Select Combo Edit for the Control type
- Click on +Add Value to add each individual file path that the key can take
- Click on +Add Filter to name and specify the file extension to use as a filter when a user is looking for a file in File Explorer.
- Click
Apply/Update
Example for Integer Radio buttons :
Setting up a key named Foryear that will take either one of these year values, 2010,2020,2030 and 2050:
- Define Name, Title and Description accordingly
- Select Integer for the value type
- Select Radio buttons for the Control type
- Click on +Add Value to add each individual year that the key can take.
- Set a default value if needed
- Click Apply/Update
To
rename a key or a category:
- Click on the item and type in the new name
- Right-click
- Double-click to open the Key Definition Editor and under name type in the new one .
To create a copy of a key:
- Key color codes:
- Category color codes: All the keys contained in a category will be equally colored, which allows to differentiate keys based on the categories they belong to:
To rearrange the display of keys in Project explorer:
- Use the Filter.. edit box to browse for a specific key or filter them based on their name.
- Click on the filter symbol
drop-down to select which keys to display either System Keys or Application
Keys or Clear any applied filters:
- Right-click on the key section in Project Explorer to display all keys or only show the categories when available.